Ellis Hughes
Fred Hutch Cancer Research Center - SCHARP - VISC
rstudio::conf(2020L)


image source: https://storage.needpix.com/rsynced_images/crowd-2045498_1280.jpg


Write Specifications
Code
Design Test Cases
Evaluate Test Cases
Document Results for Final Sign Off
1 Specification Family : 1 file
Record pertinent information
Detail
#' @title Function Specifications 001
#' @section Last updated by:
#' Ellis Hughes
#' @section Last updated date:
#' 2020-1-27
#'
+ _Specifications_
+ 1.1 Presentation must explain validation procedure.
+ 1.2 Be entertaining.
+ 1.3 Inform and document each step necessary for success.
+ 1.4 Fame and Glamour.
Define function requirements
Modularity
SOME SORT OF IMAGE/GIF
Roxygen Documentation
Unit Tests
SOME SORT OF IMAGE/GIF
Branching
Detailed code Review
#' @title Function Name
#' @description
#' Description of great function
#' @section Last updated by:
#' Ellis Hughes
#' @section Last updated date:
#' 2020-1-27
#' @param arg1 argument 1
#' @param arg2 argument 2
#' @example
#' output <- sample_function(1,2)
#'
#' @export
sample_function <- function(arg1, arg2){
temp_object <- arg1 * arg2
return(temp_object)
}
Not Unit or Regression tests
Draw connections between Specifications and Code
Detailed without writing code
How do all the pieces actually work together
Resolves interpretation errors in documentation and test cases
3rd party to code
Identify improvements
Record All elements in a single location
Following good programming practices led to
Many thanks to all involved
Fred Hutch, Managers, and Team